Aminet 1/Aminet - June 1993 [Walnut Creek].iso/aminet/misc/edu/spellcheckv1_4.lha/SP.DOC

Text File | 1991-11-16 | 15.8 KB | 467 lines

SPELLCHECK V1.4        Written by Torgeir Dingsøyr 1991-1992. FREEWARE.


            Freely distributable, as long as this documentation
            is distributed along with the program.


            FILES:         SpellCheck
                    SpellCheck.doc
                    SpellCheck.font
                    SpellCheck_Example-File

            REQUIRED FILES:    LIBS:arp.library
                    LIBS:diskfont.library
                    LIBS:powerpacker.library
            RECOMMENDED:    (LIBS:req.library)
                    (LIBS:asl.library) for 2.0 users
                    (C:run)
                    (SYS:SYSTEM/SetMap)




CONTENTS OF THIS MANUAL:
­­­­­­­­­­­­­­­­­­­­­­­­

INTRODUCTION
    What is SPELLCHECK?
    How do I use it?
    Requirements
    Questions?

1.0 The "Project" Menu
    1.1 Clear All
    1.2 Load
    1.3 Append
    1.4 Save
    1.5 Save As
    1.6 List
    1.7 Info
    1.8 About
    1.9 Quit

2.0 The "Special" Menu
    2.1 Select Keymap
    2.2 Preferences
    2.3 Shortcuts
    2.4 Low<>Uppercase
    2.5 Help Off

3.0 The "Words" Menu
    3.1 Save ASCII
    3.2 Import ASCII
    3.3 Pattern
    3.4 Uppercase
    3.5 Lowercase
    3.6 Swap

4.0 The "Ask Mode" Menu
    4.1 Automatic
    4.2 Manual

5.0 The Gadgets
    5.1 Load
    5.2 Save
    5.3 List
    5.4 Learn
    5.5 Insert

6.0 Guided Tour

APPENDIX A:    Shortcuts
APPENDIX B:    Error Codes
APPENDIX C:    Printing SPELLCHECK files
APPENDIX D:    Additional information
            Limitations
            In General
            Technical Info
            How to load 1.2 files
            Wanted
            Special Thanks
APPENDIX E:    Registered user form


INTRODUCTION.
­­­­­­­­­­­­­

What is SPELLCHECK?
SPELLCHECK is a handy program, which enables you to use your computer to
learn new words, whether it be German strong verbs, French words, or
Spanish. You type in the words you want to be heard in, and the computer
shows you the explanationand asks you to type in the German/French/
Spanish. (You can of course use any languages).

How do I use it?
The program is very easy to use, so the simplest way to find out how it
works is to try it out. Read chapter 6 for a guided tour. If you should
want to use some of the more advanced features, you should turn to this
documentation for an explanation. The program will run both from the
Workbench and from the CLI. From the CLI you may specify a filename after
SpellCheck (ie SpellCheck <filename>) and SPELLCHECK will load that file.

Requirements:
SPELLCHECK will refuse to run, if not arp.library, diskfont.library and
powerpacker.library are present in libs: It is also a must to have RUN
in C: and SETMAP in Sys:System to make full use of the program. If a
font named "SpellCheck" lies in fonts: SPELLCHECK will load and use it.
Make sure that the size is 8*8.

Questions?
If you have any questions concerning the use of this program, comments,
bugreports, or suggestions on how to improve it, please write to: PANTHEON
SOFTWORKS, Po. Box 2049-Høllen, 4641 SØGNE, NORWAY. If you want an answer,
we kindly ask you to enclose an international reply coupon. (Or stamps, if
you live in Norway). Are you using SPELLCHECK frequently, then please
fill in the registered users form in Appendix E, and mail it today!
If you have got access to internet, send e-mail to [e-mail]

The functions available from SPELLCHECK are listed here, as they appear in
the menus in the program.


1.0: THE "PROJECT" MENU:
­­­­­­­­­­­­­­­­­­­­­­­­

1.1:    * CLEAR ALL will clear all the words you have typed in or loaded
    into the program. You will get a requester, and have to click 'YES'
    or type 'Y' on the keyboard to clear all the words. To clear just
    one word read about LIST (1.6).

1.2:    * LOAD (you can also click on the gadget, or press F1) will prompt
    you with a requester, and you can select a file to load. The file
    should be a file saved from SPELLCHECK previously. SPELLCHECK
    will now load files crunched with PowerPacker.

1.3:    * APPEND (shortcut: Amiga+A). This function will add a SPELLCHECK
    file to the words that are in memory at the time. The new words will
    be put at the end of the existing words. You will get a requester to
    select the file.

1.4:    * SAVE (shortcut: Amiga+S) will save the file under the existing
    name. If no name is specified, the function will be the same as
    SAVE AS.

1.5:    * SAVE AS (shortcut: F2, also a gadget) You will have to select
    a filename in a filerequester. The file will be saved in SPELLCHECK
    format. You may also save the file as ASCII, using the function
    "Save ASCII" in the "Words" menu. (see 3.1)

1.6:    * LIST (also a gadget for this one, or F3) will open a new window,
    where you can scroll up and down, and look at all the words that
    are in memory. There are four gadgets at the bottom of the window:
    CLOSE, which brings you back to the normal window, SWAP, DELETE and
    SEARCH. When you click on a word with the mousepointer, there will
    pop up a requester in which you can edit that word. If the SWAP
    gadget is pressed down, and you click on a word, the two words
    (for instance English and German) will be swapped. If the DELETE
    gadget is pressed down, the word you click on will be deleted. If
    you click SEARCH (or press 'S' on the keyboard), you will be
    prompted with a requester, where you can type in a word to search
    after. You can use normal (ARP) wildcards here: (* and ?).
    For instance to search for all words that begin with "le", you
    type "le *" in the requester.

1.7:    * INFO gives you some information. The size of the file in memory
    is shown. (Size in memory, not on disk). The number of words in
    the file, free memory, and the comment on the current file are
    also displayed.

1.8:    * ABOUT

1.9:    * QUIT


2.0: THE "SPECIAL" MENU:
­­­­­­­­­­­­­­­­­­­­­­­­

2.1:    * SELECT KEYMAP will enable you to select a new keymap, and load
    it (a filerequester will come up). To use this function, you need
    RUN in C: and SETMAP in Sys:System.

2.2:    * PREFERENCES enables you to select your favorite colours, and to
    make SPELLCHECK load a special keymap, whenever you start it. Your
    preferences can be saved. (To the file devs:SpellCheck.prefs).

2.3:    * SHORTCUTS brings up a list over the shortcuts available from
    program.

2.4:    * LOW<>UPPERCASE. Normally SPELLCHECK will look at uppercase and
    lowercase letters as different, when it asks you in words. If you
    want uppercase and lowercase to be the same, select this menuitem,
    and it will change to LOW=UPPERCASE.

2.5:    * HELP OFF. If you select this menuitem, it will read HELP ON, so
    when you are being questioned by SPELLCHECK, you can get some help,
    by using the menu, or shortcut Amiga+H. First the program will display
    how many letters the word you are supposed to type in contains. Then
    if you press Amiga+H once more (or select Help in the menu) you will
    get the first letter, press once more, and you will get the next,
    and so on...


3.0: THE "WORDS" MENU:
­­­­­­­­­­­­­­­­­­­­­­

3.1:    * SAVE ASCII will save the words in ASCII format (handy, if you
    want to print your words). (SPELLCHECK uses a simpler way for
    saving normally - so SPELLCHECK's files will be a good deal
    larger).

3.2:    * IMPORT ASCII will load an ASCII file and add it to the words
    that are already in the memory (at the bottom). The ASCII file
    must be in this format: (For example)
                Explanation=Word<RETURN>
    If the words do not follow this format, you will get a prompt.

3.3:    * PATTERN. Here you can type in a pattern which all the words you
    will be asked in must match. If, for instance, you have loaded
    a file containing lots of german words, but only want to be heard
    in the male nouns, type in "der *" in the stringgadget.

3.4:    * UPPERCASE will turn all the letters in all the words into
    uppercase (ABCD).

3.5:    * LOWERCASE will turn all the letters in the all words into
    lowercase (abcd).

3.6:    * SWAP will swap all the words that lie in the memory. If you
    want to swap just one word, read about LIST in the "PROJECT" menu.


4.0: THE "ASK MODE: MENU:
­­­­­­­­­­­­­­­­­­­­­­­­­

    Here choose between two ways inwhich to be asked: (Select the
    current, and the other will appear).

4.1:    * AUTOMATIC. (default) You have only one chance to write the word
    correctly, if the answer was not correct, the program will show
    the right answer for a couple of seconds. (Hold down right mouse
    button to "pause" the program).

4.2:    * MANUAL. You get two chances to write the word correctly, and if
    you have answered incorrectly, you have to press <SPACE> to
    proceed.


5.0: GADGETS.
­­­­­­­­­­­­­

That was the menus, now the gadgets:

5.1:    * LOAD look under 1.2.

5.2:    * SAVE look under 'Save As', 1.5.

5.3:    * LIST look under 1.6.

5.4:    * LEARN will ask you in the words you select in the requester which
    pops up when you click this gadget (or press F4). If you have set
    a pattern (see 3.3), the words you will be questioned in must
    match that. Press 'A' for all or 'O' for OK.

5.5:    * INSERT will enable you to type in new words. The shortcut for this
    gadget is F5.


6.0: GUIDED TOUR.
­­­­­­­­­­­­­­­­­

Read this chapter for a quick journey into some of the functions of
SPELLCHECK. Load SPELLCHECK before you start reading.

Loading an example file:
In the drawer on the disk you found SPELLCHECK on, there should be a
file called "SpellCheck_Example-File". In that file, there are three
german words, with english translation. To load the file, click on the
'load'-gadget, select load in the project-menu, or press <F1>. A file-
requester will appear, and you can find the file and doubleclick it.
The words will now be loaded into memory. The number on the top right
side of the SPELLCHECK-screen should now read 003, which means that there
are three words in memory.

Setting up our preferences:
Now we want to learn some of the words. When we type in the german
translation to the english words, we want uppercase and lowecase to be
treated equally. That is, the words dog, Dog and DOG will be the same.
To disable case-apartheid, select Low<>Uppercase in the Special-menu.
It will now read Low=Uppercase.

Learning the words:
To start the learning, click on the ask-gadget, or press <F4>. A requester
will pop up, in which you can state which words you want to be asked in.
Now it reads From: 001 To 002. We want to be asked in words one and two,
so click on OK, or press <O>. At last we are ready to start learning. On
the screen the computer has typed:
What is: the dog.

On the top right, the number has changed to 001, which indicates that this
word is number one in the list. In a string-gadget there is a cursor. You
type in the german translation for 'the dog' (which is "der Hund"), and
you are off to the next word, if you entered it correctly. The screen now
reads:
What is: the car.

You probably know that the answer is "das Auto", but for now just produce a
wrong-spelling, by pressing <RETURN>. The screen will flicker, and you can
see the text WRONG! appear for a couple of seconds. A requester with results
will pop up immediately thereafter. It will read "You answered 1 words out
2 correctly. THAT IS 50 PER CENT. Below is a couple of gadgets. Click on
MISSPELLED, or press <M>. You can now retype the word that you failed to
type correct (word number two). Press return, and a new requester with
results will appear. Select STOP to end the questioning.


APPENDIX A: SHORTCUTS.
­­­­­­­­­­­­­­­­­­­­­­

        F1 - LOAD        Amiga+A - APPEND
        F2 - SAVE AS        Amiga+S - SAVE
        F3 - LIST        Amiga+Q - QUIT
        F4 - ASK              I - IMPORT ASCII
        F5 - INSERT              X - SAVE ASCII
                       HELP - SHORTCUTS

In the list-window:

         ESC - RETURN TO NORMAL WINDOW
        HOME - (7 on keypad) GOTO TOP OF LIST
         END - (1 on keypad) GOTO BOTTOM OF LIST
            ARROW UP - GO UP ONE WORD
          ARROW DOWN - GO DOWN ONE WORD
                   S - SEARCH FOR WORD


APPENDIX C: ERROR CODES.
­­­­­­­­­­­­­­­­­­­­­­­­

File Errors:

FILE ERROR 1: Unable to open file.
FILE ERROR 2: Unable to load file.
FILE ERROR 3: The file is too big.
FILE ERROR 4: Not SpellCheck V1.3+.
FILE ERROR 5: Can not find Sys:System/SetMap.
FILE ERROR 6: Unable to save file.
FILE ERROR 7: Unable to save devs:SpellCheck.prefs.

Other Errors:

NOT ENOUGH MEMORY: Unable to get memory for the window. Try to close some
other tasks to free memory. If you still can not open the window, you will
have to save and restart.
LIBRARY ERROR: SPELLCHECK was unable to open either arp.library,
diskfont.library or powerpacker.library. Ensure that they are in LIBS:
We also recommend that you put req.library in LIBS:, as this will give
you a better filerequester than the one you get with arp.library. 2.0
Users should put asl.library in LIBS: for a standard 2.0 filerequester.


APPENDIX C: PRINTING SPELLCHECK FILES.
­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­

To print your words, you must first save them as ASCII (see 3.1) and then
type in the CLI: "type <filename> to PRT:". If you want to print the words
in a more fashionable style, load the file into your favourite word-
processor, and print them from there.


APPENDIX D: ADDITIONAL INFORMATION.
­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­

Limitations:
SPELLCHECK has a maximum capacity of 384 words. This should be sufficient
for most users. Each word can only contain 40 characters (that is 40
characters for the 'explanation' and 40 for the 'word'). This will be
changed in later versions of the program.

In General:
To get out of the list-window and most of the other requesters, you can
simply press <ESCAPE>. In some, you can also press <RETURN> to make them
disappear. There are usually shortcuts to press in the requesters as
well. The first letter in the gadget-text is usually a shortcut. SPELLCHECK
makes use of string-gadgets to get input from the user. To clear the
contents of a string gadget, press RIGHT-AMIGA-X. To get back the text,
press RIGHT-AMIGA-Q.

Technical Info:
SPELLCHECK only takes up about 40kB of disk-space (uncrunched), it was
written in assembly language, using DevPac2 and DevPac 3. It makes use of
arp.library, diskfont.library and powerpacker.library from disk.

How to load 1.2 files:
If you have some old SPELLCHECK files that are saved with version 1.2 or
lower, you cannot load them directly into SPELLCHECK v1.3+. You will have
to save them as ASCII and load them as ASCII again. A program which will
convert old files will be sent on request.

Wanted:
Are you willing to translate this manual and the text in SPELLCHECK into
another language? (German/French/Spanish in particular). If you are,
please contact Pantheon Softworks.


Special thanks to:    Christian Fiott
            Tor-Martin Tveit
            Preben Randhol
            Ole Ingarth Karlsen
            Jan Reinert Karlsen
            Sigmund Vik
            Kjell Heimdal
            Jarl Nemeth

The 2.0-look on SpellCheck v1.4, and support for asl.library was made by
Preben Randhol. (Plus some other minor changes).


APPENDIX E: REGISTERED USER FORM.
­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­

Print and cut the form below, and send it to Pantheon Softworks to become
a registered user. Future versions of SPELLCHECK depend on feedback from
users. To register as a user is FREE.


                       Print and cut this part.
-------------------------------------------------------------------------
REGISTERED USER:SPELLCHECK.                                     FORM #003

DATE:__.__.__         SPELLCHECK VERSION: ____        COMPUTER: _________

NAME:____________________________________________________________________

ADDRESS:_________________________________________________________________

COUNTRY:_________________________________  KICKSTART 2.0 OR HIGHER? (Y/N)

WHY DO YOU USE SPELLCHECK?

_________________________________________________________________________

_________________________________________________________________________

WHAT DO YOU THINK OF SPELLCHECK?

_________________________________________________________________________

_________________________________________________________________________

WHICH IMPROVEMENTS WOULD YOU LIKE TO SEE IN SPELLCHECK?

_________________________________________________________________________

_________________________________________________________________________

   Send to: Pantheon Softworks, PO.BOX 2049-Høllen, 4641 Søgne, NORWAY
                    or e-mail to [e-mail]
-------------------------------------------------------------------------